home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / race160d.zip / RACEREAD.ME < prev   
Text File  |  1992-04-13  |  11KB  |  253 lines
  1.  
  2.  
  3.    ┌────── WARNING ──────────────── WARNING ─────────────── WARNING ──────┐
  4.    │                                                                      │
  5.    │    THIS IS A BETA VERSION!  This BETA version of RACE has been       │
  6.    │    released to the general public under the following conditions:    │
  7.    W                                                                      W
  8.    A      1: You accept FULL responsibility for any and all damage        A
  9.    R         this software may cause to your system because of bugs       R
  10.    N         or any other unforseen problems.                             N
  11.    I                                                                      I
  12.    N      2: You should not expect bug fixes or updates with any          N
  13.    G         regularity nor should you expect elaborate docs or           G
  14.    │         packaging.                                                   │
  15.    │                                                                      │
  16.    │                                                                      │
  17.    │                                                                      │
  18.    └────── WARNING ──────────────── WARNING ─────────────── WARNING ──────┘
  19.  
  20.  
  21. DO NOT use this software if any of the above bothers you. At this point in
  22. time, RACE v1.60 is largely untested.  It seems to work ok for me, and I
  23. made every effort to insure the quality, but stuff happens.
  24.  
  25. RACE v1.60d -
  26.  
  27. Somehow (couldn't possibly have been my fault! :-)) the old message posting
  28. code got into the new validation routines and support of the ^F codes for
  29. imported messages was lost.  FIXED.
  30.  
  31. Fixed a bug that caused RACE to error out under certain conditions when
  32. running an external pack from the RACE <U>tils menu.
  33.  
  34. Use of <V>alidation without an answer file was disabled in the previous
  35. version.  Fixed.
  36.  
  37. Added <M>ark to validation.  This will allow you to toggle a set of
  38. user answers DELETED in the index.  This will not affect the status
  39. of the user, only the answers.  The answers will only be removed after
  40. running eRACEm v0.7 with the -A switch.  Note that ALT-D toggles the
  41. answers in addition to toggling the user's deleted status so it is only
  42. necessary to use <M>ark if you want to delete a set of answers without
  43. deleting the user or vice versa.
  44.  
  45. "DELETED" appears at the top of the answer text window when a set of
  46. answers is marked deleted.  This DELETED indicator only refers
  47. to the current answer set and in no way reflects the state of the
  48. user record DELETED flag.
  49.  
  50. See the eRACEm v0.7 ERACEM.NEW file for info on packing the answer file.
  51.  
  52. RACE v1.60c - 03/22/92
  53.  
  54. WHOOPS!
  55. ------
  56. The Whoops! function has been changed to support eRACEm 0.6's writing
  57. of the users extra info (subdate, birthdate, etc.) to a USERSXI.OLD file.
  58. If you use the Whoops! function in RACE v1.60c, full support will only be
  59. achieved by using eRACEm 0.6 or above.  By saving ALL the user info,
  60. restoring a user with Whoops! will be a bit more useful.
  61.  
  62. Validation BUG FIX
  63. ------------------
  64. User subscription dates were not properly updated (again) when using a
  65. template to upgrade a user.  Fixed.
  66.  
  67. VALIDATION
  68. ----------
  69. Validation routines are in the process of being changed. If you use
  70. validation regularly as many RACE users do, I suggest you keep the current
  71. release copy of RACE until you are sure this version is working to your
  72. satisfaction.  This =IS= a beta copy!
  73.  
  74. There have been some major changes to Validation.  RACE now creates and
  75. constantly updates an index file for the answer file.  This file will have
  76. the same filename as the answer file and an extension of .IDX and it will
  77. be created in the RA system directory.  There will be one .IDX file for
  78. each answer file you view with validation.  Each record in the .IDX file
  79. (one for each set of answers) consumes 9 bytes of disk space.
  80.  
  81. Creation and updating of the index is done automatically.  RACE parses the
  82. answer file and updates the index each time you go into validation or when
  83. you <P>ick a new answer file from within validation.
  84.  
  85. RACE also does a simple test of the index before parsing.  RACE reads the
  86. last index record and attempts to go to that position in the answer file.
  87. If that position does not exist (such as when you deleted the answer file
  88. but not the index) then RACE will rebuild the index from the start.
  89.  
  90. The above test will not account for all possible problems.  If, for
  91. example, you manually edit answers out of the file then allow RA to add new
  92. answers before ever running RACE, the test may past but the last old
  93. entries in the index may not actually point to the start of a set of
  94. answers.  If in doubt, delete the .IDX file and allow RACE to rebuild it.
  95. It only takes a few seconds on average sized answer files.
  96.  
  97. This index file contains a 'last read' pointer so that RACE knows where
  98. you left off on validating during your last use of CTRL-V type validation.
  99.  
  100. This is the first record in the index.  The remaining records contain a 32
  101. bit CRC of the user name (for searching), a long integer that contains the
  102. exact byte offset of the user's answers in the answer file and an attribute
  103. byte that allow flagging a set of answers deleted when you delete the user.
  104. RACE currently sets this deleted flag but at this point in time there is no
  105. packing util to get rid of the deleted answers nor does RACE handle those
  106. records in any special way.  I do plan to create a packing util for the
  107. answer file.
  108.  
  109. You may now allow your answer file to constantly grow and not have to
  110. put up with RACE starting at the beginning each time you go into
  111. validation.  Keep in mind that the 'last read' is wherever you were when
  112. you quit last time not the highest record number you viewed.  If you jump
  113. to the first record then quit, RACE will start at the first record on your
  114. next entry to validation.
  115.  
  116. You now move forward AND backward through the answer file using the right
  117. and left arrow keys.  You may also use HOME and END to jump to the first
  118. and last set of answers respectively.  RACE no longer uses <N>ext.
  119.  
  120. FIND
  121. ----
  122. F)ind will still allow you to find other answers the currently viewed
  123. user may have but you will now be prompted "Search Forward?". <Y> or
  124. <ENTER> to this prompt will search forward otherwise hit <N> to search
  125. backwards.  Once the search has begun AND answers are found, you may move
  126. back and forth to the various answer sets of that user by using the arrow
  127. keys.  Once you are at the last set of answers for that user (in either
  128. direction), RACE reports no more answers found and the find command is
  129. toggled off.
  130.  
  131. SEARCH
  132. ------
  133. S)earch will allow you to search for a specific user's answers.  Since
  134. RACE searches the index file for a CRC match and not the answer file, it
  135. will only find EXACT matches.  Your input is converted to uppercase and
  136. then a CRC is calculated on the name.  RACE then searches the index for a
  137. match. Because of this method, partial names will never score a match since
  138. the CRC will never be exactly the same.
  139.  
  140. VIP & TRASH
  141. -----------
  142. V)ip and T)rash have been added.  These will insert the currently
  143. viewed user name into the VIP.CTL or TRASHCAN.CTL file as the command
  144. letter indicates.  Removing the user names from those files is still
  145. done by the old manual method.
  146.  
  147.  
  148. ANSWER FILE
  149. -----------
  150. If you do not care to keep your answer file around, remove the index file
  151. when you remove the answer file.  In other words, if you remove the
  152. NEWUSER.ASW, also remove the NEWUSER.IDX file.  As mentioned above, RACE
  153. attempts to handle invalid indexes but it is possible to confuse it.
  154.  
  155. The "Storage file" is no longer supported in RACE. Because of the indexing
  156. method and RACE's ability to start where you left off, it was felt that
  157. this was redundant.  The actual answer file may now be used as storage.
  158. This makes it easy to review a particular user's answers at any time while
  159. in RACE.
  160.  
  161.  
  162. INDEX STRUCTURE
  163. ---------------
  164. For those that may have some use for the answer file index that RACE
  165. creates, or if you are just curious, here's the structure.
  166.  
  167.  AnswerIdx = Record
  168.                Position  : Longint;   {byte position of start of answer text}
  169.                NameCRC   : Longint;   {32 bit CRC of uppercase name}
  170.                Attribute : Byte;      {bit 0 set = deleted}
  171.              End;
  172.  
  173. Record 0 in the index file contains (in AnswerIdx.Position) the index
  174. record number of the last answers viewed when you quit validation.
  175.  
  176. A name CRC was used in place of the actual string for space savings.  While
  177. the full name would have made searching for partial matches possible, I
  178. felt that the extra space required for the index on large answer files
  179. would have been detrimental.
  180.  
  181. RACE uses the answer start position to find the desired answers AND then
  182. looks at the next index record to get the start of the next set for the
  183. purpose of determining where the desired answers END.  So you can see that
  184. manually editing the answer file could confuse matters if you don't force
  185. RACE to re-index.
  186.  
  187.  
  188. RACE v1.60b - 02/14/92
  189.  
  190. Corrected a bug in the REPORTS portion of the code.  Going into reports
  191. and then answering 'N' to "Continue with report" would generate an error.
  192.  
  193.  
  194.  
  195.  
  196. RACE v1.60a - 01/24/92
  197.  
  198. Totally rewrote the message posting routines and improved the handling of
  199. the imported text.  RACE also now supports most, but not all, of the ^F
  200. text control codes that RemoteAccess provides.  The ^F codes are the
  201. individual user information codes. The codes may be used in any text that
  202. RACE places in the RA message base.  This includes manually typed messages
  203. using RACEEDIT or welcome messages in validation.
  204.  
  205. All valid text control codes are listed at the end of this document.
  206.  
  207. Fixed <A>dding of months in validation.  previously, if one selected <A>dd
  208. (as opposed to <R>estart) the date would have the correct number of months
  209. added but the day of the month was usually wrong.
  210.  
  211.  
  212. Added option for user name format in lists.  You may choose whether or not
  213. you want names to appear as "Lastname, Firstname" or "Firstname Lastname".
  214. This is active in REPORTS, and the 'usered' style user list screen.  Go
  215. into RACECFG => Miscellaneous to toggle this option to your desired setting.
  216.  
  217.  
  218. Packing and sorting have been removed from RACE.  This is now handled by the
  219. external 'eRACEm' utility provided with RACE.  See the eRACEm docs that
  220. accompany that file.  <W>hoops! for restoring users packed out by eRACEm
  221. is still available.  This option has replaced <K>eys in the main menu.
  222.  
  223.  
  224. The following control codes are active:
  225.  
  226. ^FA = user's full name
  227. ^FB = user's location
  228. ^F3 = user's handle
  229. ^F4 = Date of first call
  230. ^F5 = date of birth
  231. ^F6 = Subscription date
  232. ^FC = Password
  233. ^FD = Data phone number
  234. ^FE = Home phone number
  235. ^FF = Date of last call
  236. ^FG = Time of last call
  237. ^FL = NetMail credit
  238. ^FM = Total messages posted
  239. ^FO = Security level
  240. ^FP = Total calls to the BBS
  241. ^FQ = Number of uploads
  242. ^FR = Kilobytes of uploads
  243. ^FS = Number of downloads
  244. ^FT = Kilobytes of downloads
  245. ^FU = Minutes used today
  246. ^FW = user's first name
  247. ^F? = User's file ratio in number of files.
  248. ^F@ = User's file ratio in Kilobytes
  249.  
  250. If you are not familiar with how these codes work, see the RemoteAccess
  251. documentation.  RACE handles the codes in exactly the same manner.
  252.  
  253.